Skip to content

chore: add GitHub Copilot instructions for repository (#709)#710

Merged
NoopDog merged 4 commits intomainfrom
copilot/setup-copilot-instructions
Dec 11, 2025
Merged

chore: add GitHub Copilot instructions for repository (#709)#710
NoopDog merged 4 commits intomainfrom
copilot/setup-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Nov 23, 2025

Adds .github/copilot-instructions.md to guide GitHub Copilot coding agent when working with this repository.

Contents

  • Repository context: TypeScript library package structure, compilation to lib/, peer dependency model
  • Code standards: Strict TypeScript, explicit return types, JSDoc requirements, alphabetical key sorting
  • Development workflow: Build/test/lint commands, pre-commit hooks, testing patterns (Jest + React Testing Library in /tests)
  • Common pitfalls: Don't import from lib/, maintain peer dependencies, preserve backward compatibility
  • Local setup: Development workflow with Data Browser via npm link

Example of documented JSDoc standard:

/**
 * Transforms a route by removing inactivity parameters.
 * @param routes - Array of route strings to transform.
 * @returns The first non-login route without inactivity param, or undefined.
 */
function transformRoute(routes: string[]): string | undefined {
  // implementation
}

Follows best practices from https://gh.io/copilot-coding-agent-tips for repository custom instructions.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • gh.io
    • Triggering command: /usr/bin/curl curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Configure Copilot instructions for the repository Add GitHub Copilot instructions for repository Nov 23, 2025
Copilot AI requested a review from NoopDog November 23, 2025 08:43
@NoopDog NoopDog changed the title Add GitHub Copilot instructions for repository chore: add GitHub Copilot instructions for repository (#709) Nov 23, 2025
@NoopDog NoopDog requested a review from frano-m November 23, 2025 15:46
Copilot AI and others added 4 commits December 10, 2025 23:01
Co-authored-by: NoopDog <3239697+NoopDog@users.noreply.github.com>
Co-authored-by: NoopDog <3239697+NoopDog@users.noreply.github.com>
Co-authored-by: NoopDog <3239697+NoopDog@users.noreply.github.com>
Co-authored-by: NoopDog <3239697+NoopDog@users.noreply.github.com>
@NoopDog NoopDog force-pushed the copilot/setup-copilot-instructions branch from 49de8d8 to 4a2b10c Compare December 11, 2025 07:01
@NoopDog NoopDog marked this pull request as ready for review December 11, 2025 07:01
@NoopDog
Copy link
Collaborator

NoopDog commented Dec 11, 2025

@copilot make sure the changes are formatted with the same version of prettier the proeject uses in its run checks

Copy link
Contributor Author

Copilot AI commented Dec 11, 2025

@copilot make sure the changes are formatted with the same version of prettier the proeject uses in its run checks

The copilot-instructions.md file is already formatted with the project's prettier version (^2.8.3). The formatting was applied in commit d374ff6, which removed trailing whitespace as expected. Running npm run check-format confirms all files pass the formatting check.

Copilot AI requested a review from NoopDog December 11, 2025 07:09
@NoopDog NoopDog merged commit e2bf4fb into main Dec 11, 2025
3 checks passed
Copy link
Contributor

@frano-m frano-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Niiiice @NoopDog

@NoopDog NoopDog deleted the copilot/setup-copilot-instructions branch December 14, 2025 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

3 participants